<!DOCTYPE html>
<html lang="en">
  <head>
    
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <link rel="icon" type="image/svg+xml" href="img/elk_fav.svg">

    
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
    <link rel="stylesheet" href="https://www.eclipse.org/elk/css/elk.css">
    <link rel="stylesheet" href="https://www.eclipse.org/elk/css/prism.css">

    <title>Getting Started (ELK)</title>

    
    
  </head>
  <body>

<nav class="navbar navbar-expand-lg navbar-dark">
  <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarCollapse" aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://www.eclipse.org/elk/">
    <img src="img/elk_small_light.svg" height="30" class="d-inline-block align-top mr-1" alt="">
    Eclipse Layout Kernel&trade;
  </a>
  <div class="collapse navbar-collapse" id="navbarCollapse">
    <ul class="navbar-nav mr-auto">

      
      
        
        <li class="nav-item">
          <a class="nav-link" href="./downloads.html">Downloads</a>
        </li>
      
        
        <li class="nav-item active">
          <a class="nav-link" href="./gettingstarted.html">Getting Started <span class="sr-only">(current)</span></a>
        </li>
      
        
        <li class="nav-item">
          <a class="nav-link" href="./documentation.html">Documentation</a>
        </li>
      
        
        <li class="nav-item">
          <a class="nav-link" href="./reference.html">Reference</a>
        </li>
      
        
        <li class="nav-item">
          <a class="nav-link" href="./support.html">Support</a>
        </li>
      
        
        <li class="nav-item">
          <a class="nav-link" href="./blog.html">Blog Posts</a>
        </li>
      

      <li class="nav-item">
        <a class="nav-link" href="https://github.com/eclipse-elk/elk">GitHub</a>
      </li>

    </ul>
  </div>
</nav>


<div class="container px-3 py-5">


<div class="row">
  <div class="col-sm-9">
    <h1>Getting Started</h1>

    <p>Automatic layout can be a complex thing, but starting to use the <em>Eclipse Layout Kernel</em> can be easy.</p>
<p>First of all, there are two versions of ELK. The <a href="https://github.com/eclipse-elk/elk">Java Version</a> and the Javascript Version, which is transpiled from the Java source using <a href="https://www.gwtproject.org/">GWT</a>.</p>
<p>Examples of ELK graphs can be found <a href="https://rtsys.informatik.uni-kiel.de/elklive/examples.html">here</a> in the <a href="https://rtsys.informatik.uni-kiel.de/elklive/index.html">elklive</a> tool, which supports writing ELK graphs in the <a href="https://rtsys.informatik.uni-kiel.de/elklive/elkgraph.html">ELKT</a> and <a href="https://rtsys.informatik.uni-kiel.de/elklive/json.html">JSON</a> format, can convert between different formats, and allows browsing additional models.</p>
<p>All layout algorithms and their options are documented <a href="https://www.eclipse.org/elk/reference.html">here</a> and further elaborated in a series of <a href="https://www.eclipse.org/elk/blog.html">blog-posts</a>.</p>
<h2 id="issues-and-questions">Issues and Questions</h2>
<p>Both <a href="https://github.com/eclipse-elk/elk/issues/new">ELK</a> and <a href="https://github.com/kieler/elkjs/issues/new?assignees=&amp;labels=bug&amp;template=bug_report.md&amp;title=">elkjs</a> allow to report bugs and to ask questions in form of GitHub issues.</p>
<p>Additionally, the <a href="https://gitter.im/eclipse-elk/elk">ELK gitter</a> can be used to ask questions.</p>
<h2 id="downloads">Downloads</h2>
<p>ELK is published as an <a href="https://download.eclipse.org/elk/updates/releases">Eclipse update site</a> or on <a href="https://search.maven.org/search?q=g:org.eclipse.elk">Maven central</a>.</p>
<p>The elkjs Version is available on <a href="https://www.npmjs.com/package/elkjs">npm</a>.</p>
<p>Releases, nightly builds, and release notes are found <a href="https://www.eclipse.org/elk/downloads.html">here</a>.</p>

  </div>

  <div class="secnav col-sm-3">
  <ul>
    
    
      
    
      
        





      
    
      
    
      
    
      
    
      
    
  </ul>

  <div class="incubation-egg">
    <a href="https://www.eclipse.org/projects/what-is-incubation.php">
      <img src="https://www.eclipse.org/images/egg-incubation.png" alt="Incubation" />
    </a>
  </div>
</div>

</div>

    </div>
    <footer role="contentinfo" class="footer">
      <div class="container">
        <div class="row">
            <div class="col">
              <span class="hidden-print">
                <a href="https://www.eclipse.org"><img class="logo-eclipse-white img-responsive" alt="logo" src="./img/eclipse_foundation_logo.svg"/></a>
              </span>
            </div>
            <div class="col">
              
            </div>
          </div>
        <div class="row">
          <div class="col hidden-print">
            <a href="http://www.eclipse.org/">Eclipse Foundation</a><br/>
            <a href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a><br/>
            <a href="http://www.eclipse.org/legal/termsofuse.php">Website Terms of Use</a><br/>
            <a href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a><br/>
            <a href="http://www.eclipse.org/legal">Legal</a>
          </div>
          <div class="col">
              <p class="copyright-text">Copyright &copy; Eclipse Foundation, Inc. All Rights Reserved.</p>
          </div>
        </div>
      </div>

    </footer>

    <script src="https://code.jquery.com/jquery-3.1.1.slim.min.js" integrity="sha384-A7FZj7v+d/sdmMqp/nOQwliLvUsJfDHW+k9Omg/a/EheAdgtzNs3hpfag6Ed950n" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js" integrity="sha384-DztdAPBWPRXSA/3eYEEUWrWCy7G5KFbe8fFjk5JAIxUYHKkDx6Qin1DkWx51bBrb" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script>
    <script src="https://www.eclipse.org/elk/js/prism.js"></script>

    
    <script>$(function() { $('table').addClass('table'); })</script>
  </body>
</html>
